Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: fix grammar and remove patch number from Go version #596

Merged
merged 2 commits into from
Nov 17, 2023
Merged

docs: fix grammar and remove patch number from Go version #596

merged 2 commits into from
Nov 17, 2023

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Nov 17, 2023 •
edited by coderabbitai bot
Loading

Fix a minor grammar issue

Summary by CodeRabbit

  • Documentation
    • Clarified the distinction between the Blobstream P2P network and other networks in the README.
    • Updated the installation instructions for improved clarity.
    • Corrected a minor grammatical error to enhance the text quality.

@rootulp
docs: fix grammar
0292343 
Fix a minor grammar issue
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 17, 2023 •
edited
Loading

Walkthrough

The updates to the README.md file involve minor textual revisions for clarity and accuracy. The primary change is the correction of a preposition to better distinguish the Blobstream P2P network from other networks. Additionally, the Go version referenced in the installation instructions has been corrected to reflect the proper version number.

Changes

File(s) Change Summary
README.md Corrected preposition from "than" to "from" to clarify the separation of the Blobstream P2P network; updated Go version reference in installation instructions from 1.21.1 to 1.21.

🐇 In the fall, as leaves descend,
A README tweak, a tiny amend.
With words precise and version right,
Code hops along, in soft twilight. 🌔✨

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

coderabbitai[bot]
coderabbitai bot reviewed Nov 17, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 17b5716 and 0292343.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

@rootulp
docs: remove patch number from Go version
7c0239b 
Go 1.21.4 has been released and we should encourage users to use the latest Go patch release in that minor version. Since this repo doesn't depend on Go 1.21.1, proposal to just state Go 1.21
@rootulp rootulp changed the title docs: fix grammar docs: fix grammar and remove patch number from Go version Nov 17, 2023
@rootulp rootulp self-assigned this Nov 17, 2023
@rootulp rootulp added the documentation Improvements or additions to documentation label Nov 17, 2023
coderabbitai[bot]
coderabbitai bot reviewed Nov 17, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0292343 and 7c0239b.
Files selected for processing (1)
  • README.md (2 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

@rootulp
Copy link
Contributor Author

rootulp commented Nov 17, 2023

I don't have write access so @sweexordious can you please merge after reviewing?

Screenshot 2023-11-17 at 2 35 37 PM

@rach-id rach-id merged commit 1cbb5b4 into celestiaorg:main Nov 17, 2023
18 of 19 checks passed
@rootulp rootulp deleted the patch-1 branch November 17, 2023 21:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@evan-forbes evan-forbes evan-forbes approved these changes

@rach-id rach-id rach-id approved these changes

Assignees

@rootulp rootulp

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rootulp @rach-id @evan-forbes